/*
 * Copyright (c) 2005 - 2008 CAS Dev Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the CAS Dev. Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      ASMemcachedConnector.hpp
 *
 * $CAS$
 */
#ifndef _AS_MEMCACHED_CONNECTOR_HPP__
#define _AS_MEMCACHED_CONNECTOR_HPP__ 1

#include <ASLoadableObject.hpp>
#include <ASModule.hpp>

#include <STLVector.hpp>

#define C_DEFAULT_CONN_TIMEOUT   10000
#define C_DEFAULT_IO_TIMEOUT     1000
#define C_DEFAULT_ERROR_TIMEOUT  10000
#define C_DEFAULT_CONTINUUM_ELTS 100

namespace CAS_MOD
{

/**
  @class ASMemcachedConnector ASMemcachedConnector.hpp <ASMemcachedConnector.cpp>
  @brief Application server memcached connector
*/
class ASMemcachedConnector:
  public CAS::ASModule
{
public:
	/**
	  @brief A constructor
	*/
	ASMemcachedConnector();

	/**
	  @brief Initialize module
	  @param oConfiguration - module configuration
	  @param oModulesPool - pool of modules
	  @param oObjectPool - pool of objects
	  @param oLogger - logger object
	  @return 0 - if success, -1 - otherwise
	*/
	INT_32 InitModule(CTPP::CDT      & oConfiguration,
	                  CAS::ASPool    & oModulesPool,
	                  CAS::ASPool    & oObjectPool,
	                  CAS::ASLogger  & oLogger);

	/**
	  @brief Initialize server hook
	  @param oConfiguration - module configuration
	  @param oGlobalPool - pool of global objects
	  @param oServerPool - pool of per-server objects
	  @param oLogger - logger object
	  @return 0 - if success, -1 - otherwise
	*/
	INT_32 InitServer(CTPP::CDT      & oConfiguration,
	                  CAS::ASPool    & oGlobalPool,
	                  CAS::ASPool    & oServerPool,
	                  CAS::ASLogger  & oLogger);

	/**
	  @brief Get object type
	  @return human-readable type of module
	*/
	CCHAR_P GetModuleType() const;

	/**
	  @brief Get handler name
	*/
	CCHAR_P GetObjectName() const;

	/**
	  @brief A destructor
	*/
	~ASMemcachedConnector() throw();
private:
	/** Pointer to example class */
	STLW::vector<ASObject *> vObjects;

	/**
	  @brief Create and register new SQL connection
	  @param oSQL - module configuration
	  @param oGlobalPool - pool of global objects
	  @param oServerPool - pool of per-server objects
	  @param oLogger - logger object
	  @return 0 - if success, -1 - otherwise
	*/
	INT_32 CreateAndRegisterObject(CTPP::CDT      & oSQL,
	                               CAS::ASPool    & oGlobalPool,
	                               CAS::ASPool    & oServerPool,
	                               CAS::ASLogger  & oLogger);
};

EXPORT_HANDLER(ASMemcachedConnector)

} // namespace CAS_MOD
#endif // _AS_MEMCACHED_CONNECTOR_HPP__
// End.
